Inside Macintosh: QuickDraw GX Graphics /

Chapter 5 - Bitmap Shapes / Bitmap Shapes Reference

Functions / Getting and Setting Bitmap Geometries

GXGetBitmap

You can use the GXGetBitmap function to obtain a copy of the information in a bitmap shape's geometry.

gxBitmap *GXGetBitmap(gxShape source, gxBitmap *data,
                      gxPoint *position);

source

A reference to the bitmap shape whose geometry you want to copy.

data

A pointer to a gxBitmap structure. On return, this structure contains information copied from the geometry of the bitmap shape.

position

A pointer to a gxPoint structure. On return, this structure indicates the position of the upper-left corner of the bitmap shape.

function result

A pointer to a gxBitmap structure containing information from the the
geometry of the bitmap shape. This value is the same as the value you provided in the data parameter.

DESCRIPTION

The GXGetBitmap function copies the information from the geometry of the bitmap shape indicated by the source parameter to the gxBitmap structure pointed to by the data parameter and returns a pointer to this information as its function result. This function also copies the bitmap position from the bitmap geometry to the gxPoint structure pointed to by the position parameter.

You may specify nil for the data or position parameters. If you do, this function does return the corresponding information.

ERRORS, WARNINGS, AND NOTICES

Errors
out_of_memory
shape_is_nil
illegal_type_for_shape	(debugging version)

SEE ALSO

For information about the gxBitmap structure, see "The Bitmap Geometry Structure" beginning on page 5-62.

For information about pixel images, see "Bitmap Geometries" beginning on page 5-5.

To create a bitmap shape, use the GXNewBitmap function, which is described on page 5-66.

To change the geometry of a bitmap shape, use the GXSetBitmap function, which is described in the next section.

Main | Page One | What's New | Apple Computer, Inc. | Find It | Contact Us | Help